feat(function): implemented context.fail() functionality #112
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR implements the new context.fail() functionality to allow workflows to fail immediately via a special header and status code.
- Introduces a new "workflow-failed" state in the workflow processing flow.
- Updates test suites and types, along with error handling and API response construction, to support the fail behavior.
- Modifies serve options and endpoint response logic to return status 489 with the "Upstash-NonRetryable-Error" header when a workflow fails.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/workflow-requests.ts | Adds a branch to handle WorkflowAbort with failWorkflow flag. |
| src/workflow-requests.test.ts | Adds tests for context.fail() behavior validating the new workflow state. |
| src/types.ts | Extends FinishCondition to include "workflow-failed". |
| src/serve/serve.test.ts | Tests qstash failure response integration for context.fail. |
| src/serve/options.ts | Processes "workflow-failed" condition to send a Response with status 489. |
| src/serve/index.ts | Integrates handling of "workflow-failed" into the serve workflow. |
| src/serve/authorization.ts | Overrides fail() in DisabledWorkflowContext to do nothing. |
| src/error.ts | Updates WorkflowAbort to accept and assign failWorkflow flag. |
| src/context/context.ts | Adds context.fail() which throws WorkflowAbort with failWorkflow true. |
| src/context/context.test.ts | Adds tests to assert that context.fail() properly throws the expected error. |
| @@ -158,6 +159,8 @@ export const triggerRouteFunction = async ({ | |||
| return ok("workflow-was-finished"); | |||
| } else if (!(error_ instanceof WorkflowAbort)) { | |||
| return err(error_); | |||
| } else if (error_.failWorkflow) { | |||
There was a problem hiding this comment.
[nitpick] Consider restructuring the error handling logic by nesting the WorkflowAbort conditions together (i.e. checking failWorkflow and cancelWorkflow inside an explicit WorkflowAbort branch) to improve clarity.
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A special header + status combination makes a request with retries fail immediately.
header: "Upstash-NonRetryable-Error": "true"
status: 489
context.fail() is made publicly available